package com.legendframework.core.cmd;

import com.legendframework.core.dao.page.Page;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;

/**
 * 指令帮助输出接口
 */
public interface CommandHelp {

    /**
     * 获取指令帮助的每页显示条目数
     * @return
     */
    int helpItemNum();

    /**
     * 展示指令帮助列表
     *
     * 无需关注分页逻辑，只需要自定渲染风格
     *
     * @param sender 指令执行者
     * @param command 指令
     * @param help 当前准备渲染的指令封装类
     * @param cmdHelpPage 需要渲染的指令帮助列表
     */
    void renderingHelp(CommandSender sender , Command command ,CmdHelp help , Page<CmdHelp> cmdHelpPage);

}
